/**
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2020 Photon Storm Ltd.
 * @license      {@link https://opensource.org/licenses/MIT|MIT License}
 */

 var Class = require('../../utils/Class');
 var CONST = require('../const');
 var File = require('../File');
 var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
 /**
  * @classdesc
  * A single HTML File suitable for loading by the Loader.
  *
  * These are created when you use the Phaser.Loader.LoaderPlugin#html method and are not typically created directly.
  *
  * For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#html.
  *
  * @class HTMLFile
  * @extends Phaser.Loader.File
  * @memberof Phaser.Loader.FileTypes
  * @constructor
  * @since 3.12.0
  *
  * @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.
  * @param {(string|Phaser.Types.Loader.FileTypes.HTMLFileConfig)} key - The key to use for this file, or a file configuration object.
  * @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.html`, i.e. if `key` was "alien" then the URL will be "alien.html".
  * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
  */
 var HTMLFile = new Class({
 
     Extends: File,
 
     initialize:
 
     function HTMLFile (loader, key, url, xhrSettings)
     {
         var extension = 'html';
 
         if (IsPlainObject(key))
         {
             var config = key;
 
             key = GetFastValue(config, 'key');
             url = GetFastValue(config, 'url');
             xhrSettings = GetFastValue(config, 'xhrSettings');
             extension = GetFastValue(config, 'extension', extension);
         }
 
         var fileConfig = {
             type: 'text',
             cache: loader.cacheManager.html,
             extension: extension,
             responseType: 'text',
             key: key,
             url: url,
             xhrSettings: xhrSettings
         };
 
         File.call(this, loader, fileConfig);
     },
 
     /**
      * Called automatically by Loader.nextFile.
      * This method controls what extra work this File does with its loaded data.
      *
      * @method Phaser.Loader.FileTypes.HTMLFile#onProcess
      * @since 3.7.0
      */
     onProcess: function ()
     {
         this.state = CONST.FILE_PROCESSING;
 
         this.data = this.xhrLoader.responseText;
 
         this.onProcessComplete();
     }
 
 });
 
 /**
  * Adds an HTML file, or array of HTML files, to the current load queue.
  *
  * You can call this method from within your Scene's `preload`, along with any other files you wish to load:
  *
  * ```javascript
  * function preload ()
  * {
  *     this.load.html('story', 'files/LoginForm.html');
  * }
  * ```
  *
  * The file is **not** loaded right away. It is added to a queue ready to be loaded either when the loader starts,
  * or if it's already running, when the next free load slot becomes available. This happens automatically if you
  * are calling this from within the Scene's `preload` method, or a related callback. Because the file is queued
  * it means you cannot use the file immediately after calling this method, but must wait for the file to complete.
  * The typical flow for a Phaser Scene is that you load assets in the Scene's `preload` method and then when the
  * Scene's `create` method is called you are guaranteed that all of those assets are ready for use and have been
  * loaded.
  *
  * The key must be a unique String. It is used to add the file to the global HTML Cache upon a successful load.
  * The key should be unique both in terms of files being loaded and files already present in the HTML Cache.
  * Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file
  * then remove it from the HTML Cache first, before loading a new one.
  *
  * Instead of passing arguments you can pass a configuration object, such as:
  *
  * ```javascript
  * this.load.html({
  *     key: 'login',
  *     url: 'files/LoginForm.html'
  * });
  * ```
  *
  * See the documentation for `Phaser.Types.Loader.FileTypes.HTMLFileConfig` for more details.
  *
  * Once the file has finished loading you can access it from its Cache using its key:
  *
  * ```javascript
  * this.load.html('login', 'files/LoginForm.html');
  * // and later in your game ...
  * var data = this.cache.html.get('login');
  * ```
  *
  * If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files
  * key. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and
  * this is what you would use to retrieve the html from the HTML Cache.
  *
  * The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.
  *
  * If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
  * and no URL is given then the Loader will set the URL to be "story.html". It will always add `.html` as the extension, although
  * this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.
  *
  * Note: The ability to load this type of file will only be available if the HTML File type has been built into Phaser.
  * It is available in the default build but can be excluded from custom builds.
  *
  * @method Phaser.Loader.LoaderPlugin#html
  * @fires Phaser.Loader.LoaderPlugin#ADD
  * @since 3.12.0
  *
  * @param {(string|Phaser.Types.Loader.FileTypes.HTMLFileConfig|Phaser.Types.Loader.FileTypes.HTMLFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.
  * @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.html`, i.e. if `key` was "alien" then the URL will be "alien.html".
  * @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.
  *
  * @return {this} The Loader instance.
  */
 FileTypesManager.register('html', function (key, url, xhrSettings)
 {
     if (Array.isArray(key))
     {
         for (var i = 0; i < key.length; i++)
         {
             //  If it's an array it has to be an array of Objects, so we get everything out of the 'key' object
             this.addFile(new HTMLFile(this, key[i]));
         }
     }
     else
     {
         this.addFile(new HTMLFile(this, key, url, xhrSettings));
     }
 
     return this;
 });
 
 module.exports = HTMLFile;
 